API Documentation
Public Member Functions | List of all members
nkGraphics::PostProcessPass Class Reference

A post processing pass, during which a shader is used to render a quad fitting on the screen. More...

Inheritance diagram for nkGraphics::PostProcessPass:
nkGraphics::Pass nkGraphics::ProfilableClass nkExport::Exportable

Public Member Functions

ShadergetAttachedShader () const
 
bool isBackProcessPass () const
 
BlendStategetBlendState () const
 
CameragetLinkedCam () const
 
void setProcessShader (Shader *shade)
 
virtual void setBackProcess (bool value)
 
virtual void setBlendState (BlendState *state)
 
void setLinkedCam (Camera *cam)
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkGraphics::Pass
TargetOperationsgetParentTargetOperations () const
 
PASS_TYPE getPassType () const
 
const char * getName () const
 
void setParentTargetOperations (TargetOperations *parent)
 
void setName (const char *name)
 
virtual void render ()=0
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A post processing pass, during which a shader is used to render a quad fitting on the screen.

Usually works with screen space data. Perfect for applying effect on a target for instance.
See TargetOperations::addPostProcessPass() for use.

Member Function Documentation

◆ getAttachedShader()

Shader* nkGraphics::PostProcessPass::getAttachedShader ( ) const
Returns
The shader used for rendering.

◆ isBackProcessPass()

bool nkGraphics::PostProcessPass::isBackProcessPass ( ) const
Returns
Whether the post process is a back process pass (true) or not (false). See setBackProcess() for details.

◆ getBlendState()

BlendState* nkGraphics::PostProcessPass::getBlendState ( ) const
Returns
The blend state used for rendering.

◆ getLinkedCam()

Camera* nkGraphics::PostProcessPass::getLinkedCam ( ) const
Returns
The camera used for the pass.

◆ setProcessShader()

void nkGraphics::PostProcessPass::setProcessShader ( Shader shade)

Sets the shader used for rendering.

Parameters
shadeThe shader to use.

◆ setBackProcess()

virtual void nkGraphics::PostProcessPass::setBackProcess ( bool  value)
virtual

Sets whether the pass is a back process pass.
Back process passes only writes to parts of the screen that have no depth written. If disabled, the pass paints over everything.
This can be useful when painting a skybox for instance, to only execute the shader on pixels not hidden.

Parameters
valueWhether the pass should back process (true) or not (false).

◆ setBlendState()

virtual void nkGraphics::PostProcessPass::setBlendState ( BlendState state)
virtual

Sets the blend state to use for the pass.

Parameters
stateThe blend state to use.

◆ setLinkedCam()

void nkGraphics::PostProcessPass::setLinkedCam ( Camera cam)

Sets the camera to use. The camera will be the reference to feed the shader pass memory slots.

Parameters
camThe camera to use.

◆ exportClassToTree()

virtual void nkGraphics::PostProcessPass::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Reimplemented from nkGraphics::Pass.

◆ importClassFromTree()

virtual void nkGraphics::PostProcessPass::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Reimplemented from nkGraphics::Pass.


The documentation for this class was generated from the following file: